home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1998 January / Macworld (1998-01).dmg / Shareware World / Comms & Internet / HTML mode 2.0 etc. / Frontier Help < prev    next >
Text File  |  1997-08-17  |  9KB  |  210 lines
  1.  
  2.               Using Alpha as Frontier's external editor
  3.  
  4.                                Frontier menu 2.0
  5.                                  August 1997
  6.  
  7.  
  8. This document explains how to use Alpha as Frontier's external editor.
  9.  
  10. For help how to use Alpha as an HTML editor see the manual for HTML mode, 
  11. located in the folder HTML mode manual.
  12.  
  13. Please see the HTML mode home page, http://bach.theophys.kth.se/~jl/Alpha.html
  14. for the latest version of HTML mode and Frontier menu. There you can also 
  15. download the HTML mode manual if you haven't got it already.
  16.  
  17. The code have been tested with Frontier 4.2.3, but it should work with at 
  18. least 4.2 and above. However, one very useful feature was introduced in 
  19. version 4.2.3. Beginning with this version Frontier adds the suffix .html 
  20. to the file name when sending it to Alpha. This makes Alpha automatically 
  21. switch to HTML mode, which is convenient when you're editing HTML.
  22.  
  23. Please send comments and bug reports to
  24.  
  25. Johan Linde, <jl@theophys.kth.se>
  26.  
  27. Acknowledgments
  28.  
  29. Almost immediately after I had released Frontier menu 1.0 I got to know that
  30. Danis Georgiadis <dmg@hyper.gr> also had written some code to integrate 
  31. Alpha and Frontier. He generously gave me his code to freely use together 
  32. with mine. In this version I have taken the parts from his code which 
  33. could easily be integrated with mine and which worked without problems. The 
  34. Frontier database browser and the Scripts menu are both made by him. 
  35. When I made the Frontier shell I used some of Danis' code and some from 
  36. Matlab mode by Stephen Merkowitz <merk@lnf.infn.it>.
  37.  
  38. Installation and configuring
  39.  
  40. If you followed the installation instructions in the file READ ME TO 
  41. INSTALL then the file frontierMenu.tcl should be in the folder Menus 
  42. inside the folder Tcl and the file Frontier Help (this file) should be in 
  43. the folder Help.
  44.  
  45. Installing verbs into Frontier
  46.  
  47. The three files
  48. system.verbs.apps.Alpha
  49. user.html.editors.Alpha
  50. user.Alpha
  51. must be imported into Frontier. You find these find in the folder Frontier 
  52. in the install folder. Just double-click the files to import them. Frontier 
  53. will ask for a name of the imported objects. Use the ones suggested.
  54.  
  55. Note! If you have previously installed Frontier menu 1.0 you still have to 
  56. install these files. The ones distributed with Frontier menu 1.0 are not 
  57. compatible with Frontier menu 2.0.
  58.  
  59. There are also a few more changes you must do in Frontier:
  60. • Change the path in user.odbEditors.TextEditor to the path to Alpha, 
  61. otherwise Frontier will use the default editor BBEdit.
  62. • Similarly change the path in system.verbs.apps.Alpha.appinfo.path
  63. • A small change must be made to the verb suites.odbEditor.editors.Text.edit
  64.  
  65. The last lines reads
  66.  
  67. bundle «send an Apple Event to the editor to open the temp file
  68.     «use an open protocol that's implemented by BBEdit 4.0 and greater
  69.         «the extra parameter to the odoc event is Frontier's app id
  70.     appleEvent (ideditorapp, 'aevt', 'odoc', '----', alias (tempfile), 'FSnd', Frontier.id)
  71.     
  72. Change them to 
  73. bundle «send an Apple Event to the editor to open the temp file
  74.     if defined(Alpha.id) && ideditorapp == Alpha.id
  75.         Alpha.edit(tempfile)
  76.     else
  77.         «use an open protocol that's implemented by BBEdit 4.0 and greater
  78.             «the extra parameter to the odoc event is Frontier's app id
  79.         appleEvent (ideditorapp, 'aevt', 'odoc', '----', alias (tempfile), 'FSnd', Frontier.id)
  80.  
  81. This change is needed because Alpha doesn't understand the Apple event used 
  82. in the last line. Hopefully Alpha will understand it in the future so that 
  83. you don't have to make this change in the future. If you decide to switch 
  84. back to your previous editor you don't have to undo the above change. It 
  85. will work as before with any other editor.
  86.  
  87. Inserting the Frontier menu in the menu bar
  88.  
  89. The Frontier menu doesn't automatically appear in the menu bar. To insert 
  90. it in the menu bar use Config -> Global -> Menus... 
  91. Shift-click to select frontierMenu and make sure the previously selected 
  92. menus are not deselected (unless you want to remove them of course).
  93. The Frontier menu should now be inserted in the menu bar.
  94.  
  95. Opening a Frontier text window in Alpha
  96.  
  97. Text windows in Frontier can be opened in Alpha using Edit with App in 
  98. Frontier's Main menu. Whenever you save changes the Frontier database is 
  99. automatically updated. If you use 'Save as...' in Alpha the new file is 
  100. connected to the same location in the Frontier database as the old one.
  101. Thus, there is hardly any point in doing 'Save as...'.
  102.  
  103. You can also use the Frontier database browser, see below.
  104.  
  105. Note! Do not quit Frontier until you have closed all Frontier windows in 
  106. Alpha. Alpha has to tell Frontier that the windows are closed and will 
  107. launch Frontier if it is not running.
  108.  
  109. Frontier menu
  110.  
  111. Switch to Frontier - Launches Frontier or brings it to front if already 
  112.                      running.
  113.  
  114. View in Browser - Makes Frontier render the page and sends it to the 
  115.                   browser for previewing. This is the same as 'View in 
  116.                   Browser' in Frontier's Web menu. This should only be used 
  117.                   for files opened from Frontier. Other HTML files are sent 
  118.                   to the browser using 'Send File to Browser' in the HTML 
  119.                   menu.
  120.  
  121. Frontier Shell -  Opens a shell window where you can run Frontier scripts, 
  122.                   see below.
  123.                   
  124. Browse -          Opens a Frontier browser at different points in the database.
  125.                   Use Add… and Remove… to edit this menu.
  126.  
  127. Open -               Opens a Frontier window in Frontier. Use Add… and Remove… to 
  128.                   edit this menu.
  129.  
  130. Scripts Menu -       Rebuilds the Scripts menu and loads the script corresponding 
  131.                   to the menu items.
  132.  
  133. Preferences… -    To set your preferences for Frontier. Currently you can 
  134.                   choose if you want to automatically launch Frontier when 
  135.                   you launch Alpha. This is not done by default.
  136.  
  137. Scripts menu
  138.  
  139. The Scripts menu is a menu which you define inside Frontier in the same way as 
  140. you define shared menus for other applications. The menu definition must be 
  141. in user.Alpha.menubar. Alpha does not support menu sharing. Therefore there 
  142. are a few things which differ from how shared menu work. In particular:
  143.  
  144. • If you launch Frontier after Alpha the menu it not automatically inserted 
  145. in the menubar. You have to use Rebuild Scripts Menu to insert it.
  146. • Whenever you modify the menu you have to use Rebuild Scripts Menu to 
  147. rebuild it. This has also to be done if you modify a script belonging to a 
  148. menu item.
  149. • Keybindings for the menu items must be defined the way Alpha defines 
  150. keybindings. Alpha uses certain meta characters to define menu items. See 
  151. the section Menus, User Defined in the general manual.
  152.  
  153. Frontier database browser
  154.  
  155. The Frontier database browser lets you navigate through Frontier's 
  156. database without leaving Alpha. You can also open Frontier windows in 
  157. Alpha without leaving Alpha. In the browser windows, tables are red, text 
  158. windows are green, and everything else is blue. To navigate the windows 
  159. you can use key shortcuts similar to those used to navigate Finder windows.
  160.  
  161. uparrow -         move up one line
  162.  
  163. downarrow -        move down one line
  164.  
  165. rightarrow -    rightarrow on a table displays the content of the table.
  166.  
  167. leftarrow -        leftarrow on a table hides the content of the table.
  168.  
  169. cmd uparrow -    opens the parent table in a new window.
  170.  
  171. cmd-opt uparrow - opens the parent table in a new window and closes the 
  172.                   current window.
  173.  
  174. cmd downarrow -    cmd downarrow on a table opens a new window with the 
  175.                 content of that table.
  176.  
  177. cmd-opt downarrow - cmd-opt downarrow on a table opens a new window with 
  178.                 the content of that table and closes the current window.
  179.  
  180. return -        opens the selected object for editing. Text objects are opened 
  181.                 in Alpha, and most other things are opened in Frontier.
  182.  
  183. Frontier shell
  184.  
  185. The Frontier shell is an alternative to the Frontier Quick Script window 
  186. for those who like a command history. Type a command and hit return to have it 
  187. executed in Frontier. The return value is then displayed on the next line.
  188.  
  189. You move up and down the command history using control-uparrow and 
  190. control-downarrow.
  191.  
  192. Control-u erases the current line.
  193.  
  194. WARNING! Don't send commands which will make Frontier open an alert window, 
  195. like e.g. dialog.notify. If this window is hidden behind your other 
  196. windows it will freeze your machine with command-option-escape as the only 
  197. way out.
  198.  
  199. Version history
  200.  
  201. 2.0, 17 August 1997
  202. • Added a Frontier shell.
  203. • Added database browser and a Browse submenu.
  204. • Added the Open submenu.
  205. • Added Scripts menu, which is defined in Frontier as with other apps.
  206. • 'Save as...' works now.
  207.  
  208. 1.0, 20 July 1997
  209. First public release
  210.